Add Step<Run>::shell #174
Add Step<Run>::shell #174
Conversation
WalkthroughA new optional Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
crates/gh-workflow/src/step.rs (1)
137-139: Consider improving the documentation comment.The comment "Shell to run with" could be more descriptive and consistent with the documentation style used for other fields in this struct. For example, other fields use complete sentences like "The command to run in the step."
Consider updating the documentation to be more descriptive:
- /// Shell to run with + /// The shell to use when running the command. #[serde(skip_serializing_if = "Option::is_none")] pub shell: Option<String>,Alternatively, you could add more context about valid values:
- /// Shell to run with + /// The shell to use when running the command (e.g., "bash", "pwsh", "sh"). #[serde(skip_serializing_if = "Option::is_none")] pub shell: Option<String>,
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
crates/gh-workflow/src/step.rs(1 hunks)
🔇 Additional comments (1)
crates/gh-workflow/src/step.rs (1)
137-140: Implementation looks good.The
shellfield is correctly implemented:
- Follows the same pattern as other optional fields in
StepValue- Uses appropriate serde attributes to skip serialization when
None- Positioned logically after the
runfield- Will have a setter generated by
derive_setters, making it easy for users to configureThis mirrors GitHub Actions' native
shellfield and will allow users to specify custom shells for their workflow steps.
1 participant
We're trying to use gh-workflow at Zed (https://github.com/zed-industries/zed) and needed this.
Summary by CodeRabbit